Description

Commits

feat: add skipLibCheck and forceConsistentCasingInFileNames

• as defaults to the templates' tsconfigs

  • these are now recommended by TS to be set to true, which can be
    seen in the TSConfig Reference and @tsconfig/recommended
    • c.f. https://www.typescriptlang.org/tsconfig and
      https://www.npmjs.com/package/@tsconfig/recommended
  • also add to all fixtures
    • yea some centralization/extends or dogfooding create would help
      reduce all this duplication

• skipLibCheck is a big perf gain, though it seems to only affect
  tsc --noEmit usage and rollup-plugin-typescript2 seems to ignore it

  • I have an existing issue open on the matter

• forceConsistentCasingInFileNames is a no-brainer to help avoid a bug
  that is easy to make and hard to debug

• also add a trailing comma for ease of use and better diffing

  • not to fixtures though, because there is a test for this

feat: add noEmit to templates' tsconfigs

• for ease of use when using tsc for type-checking, which a lot of
  users already do

  • it doesn't fully type-check everything though, since we'd need to
    split off a tsconfig.build.json in order to let builds only run on
    src while type-checking would run on all files
    • but people already using tsc --noEmit, so might as well start
      supporting this as it's not uncommon

• also add to all fixtures

  • yea some centralization/extends or dogfooding create would help
    reduce all this duplication

docs: add comments for nearly all tsconfig options in use

• since we can use comments in tsconfig.json, add them to give simple,
  one-liner explanations as to what each setting does

• also add a link to the TSConfig Reference for further details

• and specify which options are recommended as true by TS but not on by
  default for backwards compat or other reasons

• a few leftover that I still need to think about

docs: add comment that noUnused* overlaps with an ESLint rule

• the checks overlap with the @typescript-eslint/no-unused-vars rule

• per user issue, this can result in duplicative errors inside an IDE,
  so explicitly call this out in a comment for tsdx lint / ESLint
  users in case they'd like to disable this and leave only one on

• change the ordering of linter checks in the templates as well to make
  the comments easier to read/understand

Tags

• Fixes noEmit and skipLibCheck should be on by default in TS compiler options #529 as requested, since, per noEmit and skipLibCheck should be on by default in TS compiler options #529 (comment) these are now the defaults upstream as well

• Fixes Redundant compiler options in template tsconfigs #619 , the second part about duplication with ESLint, by adding a comment as suggested in Redundant compiler options in template tsconfigs #619 (comment)

• Comments and trailing comma are a result of tsdx silently fails parsing of tsconfig files containing comments, trailing commas, etc. that TSC accepts #483 / (fix): parse tsconfig extends, trailing commas, and comments #489 , since I didn't realize this was possible before

  • I've written in several issues in a few places (can't remember them all now) that I think comments would be useful, so have finally gotten to it for most of the tsconfig (but not quite all, and not including some forced or commented out options, i.e. Buffer got wrong value when "downlevelIteration":"true" in tsconfig.json #760 (comment))
  • tsc --init has comments too as existing precedent

Review Notes

Key thing to check would be that all 3 templates and all 6 fixtures are similarly updated